Exercise - Create OpenAPI document

  • 20 minutes

The sales department needs an agent that answers their questions using information from your data. Here, you build an API specification which you need to integrate the agent with the API action. You validate how it's working against requirements to check your work.

Specification

You have an OpenAPI specification for your API.

The API specification:

  • Only contains the relevant operations
  • Includes relevant descriptions to explain the purpose of each operation and parameter

Check your work

At this point, you have an OpenAPI specification for your API. The API contains the required information to be used by the declarative agent.

  • You have a valid OpenAPI specification in JSON or YAML.
  • The API specification only contains the relevant operations.
  • Each operation in the API specification includes a meaningful summary and description.
  • Each parameter includes a meaningful description.
  • In each response, each property includes a meaningful description.